<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gnome-help</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GNOME Library Reference Manual">
<link rel="up" href="ch03.html" title="Displaying Help and External Info">
<link rel="prev" href="ch03.html" title="Displaying Help and External Info">
<link rel="next" href="libgnome-gnome-url.html" title="gnome-url">
<meta name="generator" content="GTK-Doc V1.16 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Library Reference Manual</th>
<td><a accesskey="n" href="libgnome-gnome-url.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgnome-gnome-help.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgnome-gnome-help.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgnome-gnome-help"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgnome-gnome-help.top_of_page"></a>gnome-help</span></h2>
<p>gnome-help — Display application and GNOME system help.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgnome-gnome-help.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgnome/libgnome.h&gt;

enum                <a class="link" href="libgnome-gnome-help.html#GnomeHelpError" title="enum GnomeHelpError">GnomeHelpError</a>;
#define             <a class="link" href="libgnome-gnome-help.html#GNOME-HELP-ERROR:CAPS" title="GNOME_HELP_ERROR">GNOME_HELP_ERROR</a>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgnome-gnome-help.html#gnome-help-display" title="gnome_help_display ()">gnome_help_display</a>                  (<em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *link_id</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgnome-gnome-help.html#gnome-help-display-with-doc-id" title="gnome_help_display_with_doc_id ()">gnome_help_display_with_doc_id</a>      (<em class="parameter"><code><a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="struct GnomeProgram"><span class="type">GnomeProgram</span></a> *program</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *doc_id</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *link_id</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgnome-gnome-help.html#gnome-help-display-with-doc-id-and-env" title="gnome_help_display_with_doc_id_and_env ()">gnome_help_display_with_doc_id_and_env</a>
                                                        (<em class="parameter"><code><a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="struct GnomeProgram"><span class="type">GnomeProgram</span></a> *program</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *doc_id</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *link_id</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **envp</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgnome-gnome-help.html#gnome-help-display-desktop" title="gnome_help_display_desktop ()">gnome_help_display_desktop</a>          (<em class="parameter"><code><a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="struct GnomeProgram"><span class="type">GnomeProgram</span></a> *program</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *doc_id</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *link_id</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgnome-gnome-help.html#gnome-help-display-desktop-with-env" title="gnome_help_display_desktop_with_env ()">gnome_help_display_desktop_with_env</a> (<em class="parameter"><code><a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="struct GnomeProgram"><span class="type">GnomeProgram</span></a> *program</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *doc_id</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *link_id</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **envp</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgnome-gnome-help.html#gnome-help-display-uri" title="gnome_help_display_uri ()">gnome_help_display_uri</a>              (<em class="parameter"><code>const <span class="type">char</span> *help_uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgnome-gnome-help.html#gnome-help-display-uri-with-env" title="gnome_help_display_uri_with_env ()">gnome_help_display_uri_with_env</a>     (<em class="parameter"><code>const <span class="type">char</span> *help_uri</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **envp</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgnome-gnome-help.description"></a><h2>Description</h2>
<p>
These functions provide a way to display help files that are either installed
as part of the main GNOME installation or that are specific to the current
application.
</p>
</div>
<div class="refsect1">
<a name="libgnome-gnome-help.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GnomeHelpError"></a><h3>enum GnomeHelpError</h3>
<pre class="programlisting">typedef enum {
  GNOME_HELP_ERROR_INTERNAL,
  GNOME_HELP_ERROR_NOT_FOUND
} GnomeHelpError;
</pre>
<p>
The different error codes which can be thrown in the <a class="link" href="libgnome-gnome-help.html#GNOME-HELP-ERROR:CAPS" title="GNOME_HELP_ERROR"><span class="type">GNOME_HELP_ERROR</span></a> domain.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GNOME-HELP-ERROR-INTERNAL:CAPS"></a><span class="term"><code class="literal">GNOME_HELP_ERROR_INTERNAL</code></span></p></td>
<td>Something went wrong internally. This is most
likely caused by a resource problem or bad installation.
</td>
</tr>
<tr>
<td><p><a name="GNOME-HELP-ERROR-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">GNOME_HELP_ERROR_NOT_FOUND</code></span></p></td>
<td>Help file does not exist.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GNOME-HELP-ERROR:CAPS"></a><h3>GNOME_HELP_ERROR</h3>
<pre class="programlisting">#define GNOME_HELP_ERROR (gnome_help_error_quark ())
</pre>
<p>
The class (or domain) of errors raised directly by the gnome-help module. This
is used as a value in the domain field of the <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> structure.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-help-display"></a><h3>gnome_help_display ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gnome_help_display                  (<em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *link_id</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Displays the help file specified by <em class="parameter"><code>file_name</code></em> at location <em class="parameter"><code>link_id</code></em> in the
preferred help browser of the user.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
<td>The name of the help document to display.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>link_id</code></em> :</span></p></td>
<td>Can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-help-display-with-doc-id"></a><h3>gnome_help_display_with_doc_id ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gnome_help_display_with_doc_id      (<em class="parameter"><code><a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="struct GnomeProgram"><span class="type">GnomeProgram</span></a> *program</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *doc_id</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *link_id</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Displays the help file specified by <em class="parameter"><code>file_name</code></em> at location <em class="parameter"><code>link_id</code></em> within
the <em class="parameter"><code>doc_id</code></em> domain in the preferred help browser of the user.  Most of the
time, you want to call <a class="link" href="libgnome-gnome-help.html#gnome-help-display" title="gnome_help_display ()"><code class="function">gnome_help_display()</code></a> instead.
</p>
<p>
This function will display the help through creating a "ghelp" URI, by
looking for <em class="parameter"><code>file_name</code></em> in the applications installed help location (found by
<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-APP-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_APP_HELP</span></a>) and its app_id.  The resulting URI is roughly
in the form "ghelp:appid/file_name?link_id".  If a matching file cannot be
found, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em> is set.
</p>
<p>
Please note that this only displays application help.  To display help files
from the global GNOME domain, you will want to use
<a class="link" href="libgnome-gnome-help.html#gnome-help-display-desktop" title="gnome_help_display_desktop ()"><code class="function">gnome_help_display_desktop()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td>The current application object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the default one.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></p></td>
<td>The document identifier, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to default to the application ID
(app_id) of the specified <em class="parameter"><code>program</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
<td>The name of the help document to display.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>link_id</code></em> :</span></p></td>
<td>Can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-help-display-with-doc-id-and-env"></a><h3>gnome_help_display_with_doc_id_and_env ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gnome_help_display_with_doc_id_and_env
                                                        (<em class="parameter"><code><a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="struct GnomeProgram"><span class="type">GnomeProgram</span></a> *program</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *doc_id</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *link_id</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **envp</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Like <code class="function">gnome_display_with_doc_id()</code>, but the the contents of <em class="parameter"><code>envp</code></em>
will become the url viewer's environment rather than inheriting
from the parents environment.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td>The current application object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the default one.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></p></td>
<td>The document identifier, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to default to empty string.
(app_id) of the specified <em class="parameter"><code>program</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
<td>The name of the help document to display.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>link_id</code></em> :</span></p></td>
<td>Can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
<td>child's environment, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to inherit parent's.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-help-display-desktop"></a><h3>gnome_help_display_desktop ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gnome_help_display_desktop          (<em class="parameter"><code><a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="struct GnomeProgram"><span class="type">GnomeProgram</span></a> *program</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *doc_id</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *link_id</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Displays the GNOME system help file specified by <em class="parameter"><code>file_name</code></em> at location
<em class="parameter"><code>link_id</code></em> in the preferred help browser of the user.  This is done by creating
a "ghelp" URI, by looking for <em class="parameter"><code>file_name</code></em> in the system help domain
(<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>) and it's app_id.  This domain is determined when
the library is compiled.  If a matching file cannot be found, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is
returned and <em class="parameter"><code>error</code></em> is set.
</p>
<p>
Please note that this only displays system help.  To display help files
for an application, you will want to use <a class="link" href="libgnome-gnome-help.html#gnome-help-display" title="gnome_help_display ()"><code class="function">gnome_help_display()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td>The current application object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the default one.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></p></td>
<td>The name of the help file relative to the system's help domain
(<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
<td>The name of the help document to display.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>link_id</code></em> :</span></p></td>
<td>Can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-help-display-desktop-with-env"></a><h3>gnome_help_display_desktop_with_env ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gnome_help_display_desktop_with_env (<em class="parameter"><code><a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="struct GnomeProgram"><span class="type">GnomeProgram</span></a> *program</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *doc_id</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *link_id</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **envp</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Like <a class="link" href="libgnome-gnome-help.html#gnome-help-display-desktop" title="gnome_help_display_desktop ()"><code class="function">gnome_help_display_desktop()</code></a>, but the the contents of <em class="parameter"><code>envp</code></em>
will become the url viewer's environment rather than inheriting
from the parents environment.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td>The current application object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the default one.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></p></td>
<td>The name of the help file relative to the system's help domain
(<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
<td>The name of the help document to display.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>link_id</code></em> :</span></p></td>
<td>Can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
<td>child's environment, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to inherit parent's.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-help-display-uri"></a><h3>gnome_help_display_uri ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gnome_help_display_uri              (<em class="parameter"><code>const <span class="type">char</span> *help_uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Displays <em class="parameter"><code>help_uri</code></em> in the user's preferred viewer. You should never need to
call this function directly in code, since it is just a wrapper for
<a class="link" href="libgnome-gnome-url.html#gnome-url-show" title="gnome_url_show ()"><code class="function">gnome_url_show()</code></a> and consequently the viewer used to display the results
depends upon the scheme of the URI (so it is not strictly a help-only
function).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>help_uri</code></em> :</span></p></td>
<td>The URI to display.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-help-display-uri-with-env"></a><h3>gnome_help_display_uri_with_env ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gnome_help_display_uri_with_env     (<em class="parameter"><code>const <span class="type">char</span> *help_uri</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **envp</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Like <a class="link" href="libgnome-gnome-help.html#gnome-help-display-uri" title="gnome_help_display_uri ()"><code class="function">gnome_help_display_uri()</code></a>, but the the contents of <em class="parameter"><code>envp</code></em>
will become the help viewer's environment rather than inheriting
from the parents environment.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>help_uri</code></em> :</span></p></td>
<td>The URI to display.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
<td>child's environment, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to inherit parent's.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.16</div>
</body>
</html>